!--------------------------------------------------------------------------------------------------!
!   CP2K: A general program to perform molecular dynamics simulations                              !
!   Copyright 2000-2024 CP2K developers group <https://cp2k.org>                                   !
!                                                                                                  !
!   SPDX-License-Identifier: GPL-2.0-or-later                                                      !
!--------------------------------------------------------------------------------------------------!

! **************************************************************************************************
!> \brief Declares the input for swarm framework
!> \author Ole Schuett
! **************************************************************************************************
MODULE swarm_input
   USE cp_output_handling,              ONLY: add_last_numeric,&
                                              cp_print_key_section_create,&
                                              low_print_level
   USE glbopt_input,                    ONLY: glbopt_declare_input
   USE input_constants,                 ONLY: swarm_do_glbopt
   USE input_keyword_types,             ONLY: keyword_create,&
                                              keyword_release,&
                                              keyword_type
   USE input_section_types,             ONLY: section_add_keyword,&
                                              section_add_subsection,&
                                              section_create,&
                                              section_release,&
                                              section_type
   USE input_val_types,                 ONLY: integer_t
   USE string_utilities,                ONLY: s2a
#include "../base/base_uses.f90"

   IMPLICIT NONE
   PRIVATE

   CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'swarm_input'

   PUBLIC :: create_swarm_section

CONTAINS

! **************************************************************************************************
!> \brief Declares the SWARM input section
!> \param swarm_section ...
!> \author Ole Schuett
! **************************************************************************************************
   SUBROUTINE create_swarm_section(swarm_section)
      TYPE(section_type), POINTER                        :: swarm_section

      TYPE(keyword_type), POINTER                        :: keyword
      TYPE(section_type), POINTER                        :: print_section, printkey

      NULLIFY (swarm_section, print_section, printkey, keyword)

      CALL section_create(swarm_section, __LOCATION__, name="SWARM", &
                          description="Section to control swarm runs. "// &
                          "The swarm framework provides a common ground for master/worker algorithms.", &
                          repeats=.FALSE.)

      CALL keyword_create(keyword, __LOCATION__, name="BEHAVIOR", &
                          description="Which behaviour should control the swarm.", &
                          usage="BEHAVIOR <STRING>", &
                          default_i_val=swarm_do_glbopt, &
                          enum_c_vals=s2a("GLOBAL_OPT"), &
                          enum_desc=s2a("Runs global geometry optimisation"), &
                          enum_i_vals=(/swarm_do_glbopt/))
      CALL section_add_keyword(swarm_section, keyword)
      CALL keyword_release(keyword)

      CALL keyword_create(keyword, __LOCATION__, name="NUMBER_OF_WORKERS", &
                          description="Number of workers used for swarm. "// &
                          "Of the total number of processors one is used for the master, "// &
                          "the remaining processors should be divisible by the number of workers.", &
                          type_of_var=integer_t)
      CALL section_add_keyword(swarm_section, keyword)
      CALL keyword_release(keyword)

      CALL keyword_create(keyword, __LOCATION__, name="REPLAY_COMMUNICATION_LOG", &
                          description="Filename of communication log of previous run. Use this to restart a swarm.", &
                          repeats=.FALSE., &
                          usage="REPLAY_COMMUNICATION_LOG <CHARACTER>", default_lc_val="swarm_translog_replay.xyz")
      CALL section_add_keyword(swarm_section, keyword)
      CALL keyword_release(keyword)

      CALL keyword_create(keyword, __LOCATION__, name="MAX_ITER", &
                          description="The maximum number iterations the master should perform", &
                          type_of_var=integer_t, default_i_val=HUGE(1))
      CALL section_add_keyword(swarm_section, keyword)
      CALL keyword_release(keyword)

      CALL section_create(print_section, __LOCATION__, name="PRINT", &
                          description="Controls the printing properties during a global optimization run", &
                          n_keywords=0, n_subsections=1, repeats=.TRUE.)

      CALL cp_print_key_section_create( &
         printkey, __LOCATION__, "WORKER_RUN_INFO", &
         description="Controls the printing of the worker's basic information during the global optimization", &
         print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
      CALL section_add_subsection(print_section, printkey)
      CALL section_release(printkey)

      CALL cp_print_key_section_create( &
         printkey, __LOCATION__, "MASTER_RUN_INFO", &
         description="Controls the printing of the masters's basic information during the global optimization", &
         print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
      CALL section_add_subsection(print_section, printkey)
      CALL section_release(printkey)

      CALL cp_print_key_section_create(printkey, __LOCATION__, "COMMUNICATION_LOG", &
                                       description="Log all the communication between workers and master. Needed for restart.", &
                                       print_level=low_print_level, common_iter_levels=1, &
                                       filename="", unit_str="angstrom")
      CALL section_add_subsection(print_section, printkey)
      CALL section_release(printkey)

      CALL section_add_subsection(swarm_section, print_section)
      CALL section_release(print_section)

      CALL glbopt_declare_input(swarm_section)

   END SUBROUTINE create_swarm_section

END MODULE swarm_input

